fix: add explicit mapping for cancelled status #2291

ab-ghosh · 2025-10-14T11:15:46Z

Add case for 'cancelled' conclusion in GitLab provider CreateStatus
Map 'cancelled' to 'canceled' for GitLab API compatibility
Add unit test to verify cancelled status handling

📝 Description of the Change

👨🏻‍ Linked Jira

https://issues.redhat.com/browse/SRVKP-9050

🔗 Linked GitHub Issue

Fixes #

🚀 Type of Change

🧪 Testing Strategy

🤖 AI Assistance

I have not used any AI assistance for this PR.
I have used AI assistance for this PR.

If you have used AI assistance, please provide the following details:

Which LLM was used?

Extent of AI Assistance:

Documentation and research only
Unit tests or E2E tests only
Code generation (parts of the code)
Full code generation (most of the PR)
PR description and comments
Commit message(s)

Important

If the majority of the code in this PR was generated by an AI, please add a Co-authored-by trailer to your commit message.
For example:

Co-authored-by: Gemini [email protected]
Co-authored-by: ChatGPT [email protected]
Co-authored-by: Claude [email protected]
Co-authored-by: Cursor [email protected]
Co-authored-by: Copilot [email protected]

**💡You can use the script ./hack/add-llm-coauthor.sh to automatically add
these co-author trailers to your commits.

✅ Submitter Checklist

gemini-code-assist · 2025-10-14T11:16:00Z

Summary of Changes

Hello @ab-ghosh, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves an issue where the GitLab provider did not correctly interpret the 'cancelled' status. It introduces a specific case to map 'cancelled' to 'canceled' for GitLab API compatibility and sets an appropriate status title. A corresponding unit test has been added to ensure the new handling works as expected.

Highlights

GitLab Status Handling: Added explicit handling for the 'cancelled' status within the GitLab provider's CreateStatus function.
API Compatibility: Mapped the 'cancelled' conclusion to 'canceled' to ensure proper compatibility with the GitLab API.
Unit Testing: Included a new unit test to verify that the 'cancelled' status is correctly processed and mapped.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

pipelines-as-code · 2025-10-14T11:16:30Z

🔍 PR Lint Feedback

Note: This automated check helps ensure your PR follows our contribution guidelines.

⚠️ Items that need attention:

🤖 AI attribution

The following commits lack an explicit AI attribution footer:

8bb9a66 fix(gitlab): add explicit mapping for cancelled status
b040b54 chore(linter): enforce British spelling 'cancelled' over 'canceled'

If no AI assistance was used for a commit, you can ignore this warning.
Otherwise add an Assisted-by: or Co-authored-by: footer referencing the AI used.

ℹ️ Next Steps

Review and address the items above
Push new commits to update this PR
This comment will be automatically updated when issues are resolved

🔧 Admin Tools (click to expand)

Automated Issue/Ticket Creation:

/issue-create - Generate a GitHub issue from this PR content using AI
/jira-create - Create a SRVKP Jira ticket from this PR content using AI

⚠️ Important: Always review and edit generated content before finalizing tickets/issues.
The AI-generated content should be used as a starting point and may need adjustments.

These commands are available to maintainers and will post the generated content as PR comments for review.

_{🤖 This feedback was generated automatically by the PR CI system}

gemini-code-assist

Code Review

This pull request correctly adds support for the 'cancelled' status in the GitLab provider by mapping it to 'canceled' for API compatibility, and includes a unit test to verify the new logic. The implementation is sound. I have one suggestion to refactor the code slightly by combining similar cases, which would improve code clarity and maintainability.

pkg/provider/gitlab/gitlab.go

chmouel · 2025-10-14T11:21:19Z

can we fix canceled across the codebase ?

ab-ghosh · 2025-10-14T11:36:53Z

I've reviewed the codebase and didn't find any other inconsistencies related to the use of “canceled” for GitLab.

zakisk · 2025-10-14T11:53:36Z

can we fix canceled across the codebase ?

@chmouel what do you mean by fixing? removing?

theakshaypant

Feel free to resolve the comment if it is incorrect, added the comment more for learning for myself.

pkg/provider/gitlab/gitlab_test.go

ab-ghosh · 2025-10-23T07:21:48Z

Hi @chmouel @zakisk ,could you please confirm if any further changes are needed, or can we proceed with merging this PR?

zakisk · 2025-10-23T07:25:58Z

Hi @chmouel @zakisk ,could you please confirm if any further changes are needed, or can we proceed with merging this PR?

E2E tests are not running for you and we're adding membership check in this PR #2285 after its CI succeeds we can merge it, and then you need to rebase with main

zakisk · 2025-10-23T07:28:20Z

Or I will go with failed CI as well because its just workflow yaml changes doesn't affect E2E anyway

chmouel · 2025-10-23T09:30:35Z

Bear in mind working on it, this PR make a good use case for user permission test and need to iterate with it

chmouel · 2025-10-23T10:12:39Z

can we fix canceled across the codebase ?

@chmouel what do you mean by fixing? removing?

@zakisk i mean this

% rg --no-heading -n  --hidden --color=always --hyperlink-format=kitty -w canceled
.vale/styles/RedHat/TermsErrors.yml:98:  cancelled: canceled
docs/content/docs/guide/running.md:167:Older `PipelineRuns` are canceled only after the latest `PipelineRun` is
docs/content/docs/guide/running.md:172:the `PipelineRun` will be canceled.
test/gitlab_merge_request_test.go:363:	runcnx.Clients.Log.Infof("Waiting for old pipelinerun to be canceled")
test/gitlab_merge_request_test.go:432:	assert.Equal(t, prs.Items[0].GetStatusCondition().GetCondition(apis.ConditionSucceeded).GetReason(), "Cancelled", "should have been canceled")
test/gitlab_merge_request_test.go:600:		case "failed", "canceled", "skipped":
test/github_pullrequest_test.go:342:	g.Cnx.Clients.Log.Infof("Sleeping for 10 seconds to let the pipelinerun to be canceled")
test/github_pullrequest_test.go:360:				g.Cnx.Clients.Log.Infof("PipelineRun %s has been canceled", pr.Name)
test/github_pullrequest_test.go:403:	g.Cnx.Clients.Log.Infof("Sleeping for 10 seconds to let the pipelinerun to be canceled")
test/github_pullrequest_test.go:406:	g.Cnx.Clients.Log.Infof("Checking that the pipelinerun has been canceled")
test/github_pullrequest_test.go:412:	assert.Equal(t, prs.Items[0].GetStatusCondition().GetCondition(apis.ConditionSucceeded).GetReason(), "Cancelled", "should have been canceled")
test/github_pullrequest_retest_test.go:125:	// go over all pruns check that at least one is canceled and the other two are succeeded
test/github_pullrequest_retest_test.go:143:	assert.Equal(t, canceledCount, 1, "should have one canceled PipelineRun")
test/gitea_test.go:543:	assert.Equal(t, cancelledPr, 1, "only one pr should have been canceled")
test/gitea_test.go:557:	assert.Equal(t, cancelledPr, 2, "tweo pr should have been canceled")
test/gitea_test.go:589:	topts.ParamsRun.Clients.Log.Info("Waiting 10 seconds to check things has been canceled")
test/gitea_test.go:596:	assert.Equal(t, prs.Items[0].GetStatusCondition().GetCondition(apis.ConditionSucceeded).GetReason(), "Cancelled", "should have been canceled")
pkg/reconciler/reconciler.go:109:	// if status is not pending, it could be canceled so let it be reported, even if state is queued
pkg/provider/gitlab/gitlab.go:261:		statusOpts.Conclusion = "canceled"
pkg/provider/gitlab/gitlab.go:264:		statusOpts.Conclusion = "canceled"
test/github_push_retest_test.go:175:	g.Cnx.Clients.Log.Infof("Waiting for Repository to be updated still to %d since it has been canceled", numberOfStatus)
test/github_push_retest_test.go:176:	repo, _ := twait.UntilRepositoryUpdated(ctx, g.Cnx.Clients, waitOpts) // don't check for error, because canceled is not success and this will fail
test/bitbucket_cloud_pullrequest_test.go:101:	runcnx.Clients.Log.Info("Waiting 10 seconds to check things has been canceled")
test/bitbucket_cloud_pullrequest_test.go:108:	assert.Equal(t, prs.Items[0].GetStatusCondition().GetCondition(apis.ConditionSucceeded).GetReason(), "Cancelled", "should have been canceled")
pkg/cmd/tknpac/resolve/basic_auth_secret.go:80:			return "", "", fmt.Errorf("canceled")
pkg/cmd/tknpac/resolve/basic_auth_secret.go:85:				return "", "", fmt.Errorf("canceled")
.git/rr-cache/7b611ee6fa553aab35fbe2bc83c3d19bbdac9eff/postimage:261:		statusOpts.Conclusion = "canceled"
.git/rr-cache/7b611ee6fa553aab35fbe2bc83c3d19bbdac9eff/postimage:264:		statusOpts.Conclusion = "canceled"
.git/rr-cache/7b611ee6fa553aab35fbe2bc83c3d19bbdac9eff/preimage:261:		statusOpts.Conclusion = "canceled"
.git/rr-cache/7b611ee6fa553aab35fbe2bc83c3d19bbdac9eff/preimage:264:		statusOpts.Conclusion = "canceled"
󰘬 ~/git/pac/trees/main main ≡1

I thought we just standardize everywhere on the american wording (cancelled) instead of using canceled

zakisk · 2025-10-23T10:48:31Z

@zakisk i mean this

ah, okay makes sense!

zakisk · 2025-10-23T10:49:20Z

I thought we just standardize everywhere on the american wording (cancelled) instead of using canceled

@ab-ghosh feel free to find and change the docs/log messages having "canceled"

chmouel · 2025-10-23T10:51:57Z

We need to figure out how to get the misspelling linter, or via golangci-lint, to flag for us some specific words used. I think it's possible if you can try to investigate that; that would be great, Abishek 🙏🏻

theakshaypant · 2025-10-23T14:10:02Z

We need to figure out how to get the misspelling linter, or via golangci-lint, to flag for us some specific words used. I think it's possible if you can try to investigate that; that would be great, Abishek 🙏🏻

I think this might be helpful.

ab-ghosh · 2025-10-23T15:15:48Z

I think this might be helpful.

@theakshaypant Yes, this should work, I was trying this.

zakisk · 2025-10-24T10:54:01Z

.golangci.yml

+      - linters:
+          - misspell
+        path: pkg/provider/gitlab/gitlab\.go
+        text: '`canceled` is a misspelling of `cancelled`'


Suggested change

text: '`canceled` is a misspelling of `cancelled`'

text: 'found `canceled` it must be `cancelled`'

you can't say that its misspelled as its just a other dialect of English some might choose to write 🙂

maybe better:

use american english version of the word `cancelled` as `canceled` with one L

@zakisk this text field in the exclusion rule is not a custom message, it needs to exactly match the error message generated by the misspell linter itself. This is because golangci-lint uses it to pattern match against the linter's output when applying exclusions. In this case, I'm trying to exclude the files related to GitLab.

ah, yeah I didn't know that but in that can you can suppress the lint on CreateStatus func in gitlab.go using comment on it //nolint:misspell

Thanks, @zakisk! I will suppress the lint just for that function.

zakisk · 2025-10-24T10:54:17Z

.golangci.yml

+      - linters:
+          - misspell
+        path: test/gitlab.*\.go
+        text: '`canceled` is a misspelling of `cancelled`'


zakisk · 2025-10-27T04:48:39Z

/test

- Add case for 'cancelled' conclusion in GitLab provider CreateStatus - Map 'cancelled' to 'canceled' for GitLab API compatibility - Set descriptive title 'cancelled validating this commit' - Ensures proper status reporting when PipelineRuns are cancelled via PR close

Add misspell linter configuration to enforce consistent use of 'cancelled' (British spelling) across the codebase. Update all internal code, comments, and test assertions to use 'cancelled'. Exclude GitLab provider code and test files from this rule, as GitLab's API requires 'canceled' (American spelling) for compatibility. Changes: - Configure misspell linter in .golangci.yml - Fix spelling in pkg/cmd/tknpac and pkg/reconciler - Update test files to use 'cancelled' - Add exclusions for GitLab API-related code Signed-off-by: ab-ghosh <[email protected]>

pipelines-as-code bot added fix gitlab testing labels Oct 14, 2025

gemini-code-assist bot reviewed Oct 14, 2025

View reviewed changes

pkg/provider/gitlab/gitlab.go Show resolved Hide resolved

theakshaypant reviewed Oct 14, 2025

View reviewed changes

pkg/provider/gitlab/gitlab_test.go Show resolved Hide resolved

ab-ghosh force-pushed the fix/gitlab-canceled-status-mapping branch 2 times, most recently from 7133c5c to 922f701 Compare October 24, 2025 07:42

ab-ghosh requested review from chmouel, theakshaypant and zakisk October 24, 2025 08:52

zakisk reviewed Oct 24, 2025

View reviewed changes

ab-ghosh force-pushed the fix/gitlab-canceled-status-mapping branch from 922f701 to 9787dcc Compare October 26, 2025 18:03

zakisk force-pushed the fix/gitlab-canceled-status-mapping branch from 9787dcc to b040b54 Compare October 27, 2025 04:49

zakisk approved these changes Oct 27, 2025

View reviewed changes

zakisk merged commit 8a3103c into openshift-pipelines:main Oct 27, 2025
5 checks passed

	text: '`canceled` is a misspelling of `cancelled`'
	text: 'found `canceled` it must be `cancelled`'

Uh oh!

fix: add explicit mapping for cancelled status #2291

fix: add explicit mapping for cancelled status #2291

Conversation

ab-ghosh commented Oct 14, 2025

📝 Description of the Change

👨🏻‍ Linked Jira

🔗 Linked GitHub Issue

🚀 Type of Change

🧪 Testing Strategy

🤖 AI Assistance

✅ Submitter Checklist

Uh oh!

gemini-code-assist bot commented Oct 14, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

pipelines-as-code bot commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔍 PR Lint Feedback

⚠️ Items that need attention:

🤖 AI attribution

ℹ️ Next Steps

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

chmouel commented Oct 14, 2025

Uh oh!

ab-ghosh commented Oct 14, 2025

Uh oh!

zakisk commented Oct 14, 2025

Uh oh!

theakshaypant left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ab-ghosh commented Oct 23, 2025

Uh oh!

zakisk commented Oct 23, 2025

Uh oh!

zakisk commented Oct 23, 2025

Uh oh!

chmouel commented Oct 23, 2025

Uh oh!

chmouel commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zakisk commented Oct 23, 2025

Uh oh!

zakisk commented Oct 23, 2025

Uh oh!

chmouel commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

theakshaypant commented Oct 23, 2025

Uh oh!

ab-ghosh commented Oct 23, 2025

Uh oh!

zakisk Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

chmouel Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ab-ghosh Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

zakisk Oct 26, 2025

Choose a reason for hiding this comment

Uh oh!

ab-ghosh Oct 26, 2025

Choose a reason for hiding this comment

Uh oh!

zakisk Oct 24, 2025

Choose a reason for hiding this comment

pipelines-as-code bot commented Oct 14, 2025 •

edited

Loading

chmouel commented Oct 23, 2025 •

edited

Loading

chmouel commented Oct 23, 2025 •

edited

Loading

chmouel Oct 24, 2025 •

edited

Loading